Support requesting a specific IP address in cloudstack_ipaddress - #311
Merged
Conversation
sudo87
requested review from
vishesh92
and
a lite review from Copilot
and removed request for
Copilot
August 12, 2026 06:48
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds support for requesting a specific public IP address in the cloudstack_ipaddress Terraform resource by exposing ip_address as a configurable argument and passing it through to CloudStack’s associateIpAddress API.
Changes:
- Updated the
cloudstack_ipaddressschema to makeip_addressOptional + Computed + ForceNew. - Updated resource create logic to call
AssociateIpAddressParams.SetIpaddress(...)whenip_addressis provided. - Added documentation and a new acceptance test covering the new argument.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cloudstack/resource_cloudstack_ipaddress.go | Exposes ip_address as an optional ForceNew argument and forwards it to the CloudStack API on create. |
| cloudstack/resource_cloudstack_ipaddress_test.go | Adds an acceptance test intended to verify requesting a specific IP address. |
| website/docs/r/ipaddress.html.markdown | Documents the new ip_address argument and its ForceNew behavior. |
Suppressed comments (2)
cloudstack/resource_cloudstack_ipaddress_test.go:211
- To make
TestAccCloudStackIPAddress_specificIPvalidate the newip_addressbehavior, the dedicated VLAN range should include at least two addresses so CloudStack's default auto-allocation would likely choose a different IP than the one requested.
end_ip = "10.2.2.10"
cloudstack/resource_cloudstack_ipaddress_test.go:225
- This should request the non-default address from the dedicated VLAN range (e.g. the range's
end_ip) so the test exercises theip_addressrequest path rather than succeeding due to auto-selection.
ip_address = cloudstack_vlan_ip_range.foo.start_ip
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Suppressed comments (1)
cloudstack/resource_cloudstack_ipaddress_test.go:221
- In the new acceptance test,
cloudstack_network.foosetssource_nat_ip = true. That triggers an extraassociateIpAddressduring network creation, which can consume one of the IPs from the dedicatedcloudstack_vlan_ip_range(and it does not depend on that range), making the test potentially flaky/non-deterministic. For this test, omitsource_nat_ipso the only allocation is thecloudstack_ipaddressrequesting the specific address.
resource "cloudstack_network" "foo" {
name = "terraform-network"
display_text = "terraform-network"
cidr = "10.1.1.0/24"
network_offering = "DefaultIsolatedNetworkOfferingWithSourceNatService"
source_nat_ip = true
zone = "Sandbox-simulator"
kiranchavala
approved these changes
Aug 17, 2026
kiranchavala
left a comment
kiranchavala
left a comment
Member
There was a problem hiding this comment.
LGTM tested manually
resource "cloudstack_network" "foo" {
name = "terraform-network"
display_text = "terraform-network"
cidr = "10.1.1.0/24"
network_offering = "DefaultIsolatedNetworkOfferingWithSourceNatService"
source_nat_ip = true
zone = "4b6856cb-a3c3-4e9b-b0c4-f2c5bfa54667"
}
resource "cloudstack_ipaddress" "foo" {
network_id = cloudstack_network.foo.id
ip_address = "192.168.55.55"
}
terraform apply
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated
with the following symbols:
+ create
Terraform will perform the following actions:
# cloudstack_ipaddress.foo will be created
+ resource "cloudstack_ipaddress" "foo" {
+ id = (known after apply)
+ ip_address = "192.168.55.55"
+ is_portable = false
+ is_source_nat = (known after apply)
+ network_id = (known after apply)
+ project = (known after apply)
+ tags = (known after apply)
}
# cloudstack_network.foo will be created
+ resource "cloudstack_network" "foo" {
+ acl_id = "none"
+ cidr = "10.1.1.0/24"
+ display_text = "terraform-network"
+ endip = (known after apply)
+ gateway = (known after apply)
+ id = (known after apply)
+ name = "terraform-network"
+ network_domain = (known after apply)
+ network_offering = "DefaultIsolatedNetworkOfferingWithSourceNatService"
+ project = (known after apply)
+ source_nat_ip = true
+ source_nat_ip_address = (known after apply)
+ source_nat_ip_id = (known after apply)
+ startip = (known after apply)
+ tags = (known after apply)
+ zone = "4b6856cb-a3c3-4e9b-b0c4-f2c5bfa54667"
}
Plan: 2 to add, 0 to change, 0 to destroy.
Do you want to perform these actions?
Terraform will perform the actions described above.
Only 'yes' will be accepted to approve.
Enter a value: yes
cloudstack_network.foo: Creating...
cloudstack_network.foo: Creation complete after 1s [id=d203173c-8ee2-4b43-94f1-509152e56437]
cloudstack_ipaddress.foo: Creating...
cloudstack_ipaddress.foo: Creation complete after 2s [id=033d3365-3b61-4de4-8ead-37116365bbc8]
Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
terraform destroy
cloudstack_network.foo: Refreshing state... [id=d203173c-8ee2-4b43-94f1-509152e56437]
cloudstack_ipaddress.foo: Refreshing state... [id=033d3365-3b61-4de4-8ead-37116365bbc8]
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated
with the following symbols:
- destroy
Terraform will perform the following actions:
# cloudstack_ipaddress.foo will be destroyed
- resource "cloudstack_ipaddress" "foo" {
- id = "033d3365-3b61-4de4-8ead-37116365bbc8" -> null
- ip_address = "192.168.55.55" -> null
- is_portable = false -> null
- is_source_nat = false -> null
- network_id = "d203173c-8ee2-4b43-94f1-509152e56437" -> null
- tags = {} -> null
# (1 unchanged attribute hidden)
}
# cloudstack_network.foo will be destroyed
- resource "cloudstack_network" "foo" {
- acl_id = "none" -> null
- cidr = "10.1.1.0/24" -> null
- display_text = "terraform-network" -> null
- gateway = "10.1.1.1" -> null
- id = "d203173c-8ee2-4b43-94f1-509152e56437" -> null
- name = "terraform-network" -> null
- network_domain = "cs2cloud.internal" -> null
- network_offering = "DefaultIsolatedNetworkOfferingWithSourceNatService" -> null
- source_nat_ip = true -> null
- source_nat_ip_address = "192.168.55.54" -> null
- source_nat_ip_id = "72475eaa-e023-450f-b0ac-b3f3d812f6cc" -> null
- tags = {} -> null
- zone = "4b6856cb-a3c3-4e9b-b0c4-f2c5bfa54667" -> null
# (2 unchanged attributes hidden)
}
Plan: 0 to add, 0 to change, 2 to destroy.
Do you really want to destroy all resources?
Terraform will destroy all your managed infrastructure, as shown above.
There is no undo. Only 'yes' will be accepted to confirm.
Enter a value: yes
cloudstack_ipaddress.foo: Destroying... [id=033d3365-3b61-4de4-8ead-37116365bbc8]
cloudstack_ipaddress.foo: Destruction complete after 1s
cloudstack_network.foo: Destroying... [id=d203173c-8ee2-4b43-94f1-509152e56437]
cloudstack_network.foo: Destruction complete after 1s
Destroy complete! Resources: 2 destroyed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cloudstack_ipaddresscurrently always lets CloudStack auto-select the nextfree IP — there's no way to request a specific address. This blocks a common
pattern: an operator dedicates an intranet VLAN/IP range to an account, and
the tenant needs to acquire one particular address from it (e.g. because
firewall rules, DNS, or routing on the corporate side are already provisioned
for that exact IP).
The CloudStack API (
associateIpAddress) already accepts an optionalipaddressparameter; the provider never called it.Fixes #291
Changes
ip_addresschanges fromComputed-only toOptional + Computed + ForceNew.There's no CloudStack API to change an IP association in place, so a change
to
ip_addresscorrectly triggers destroy+recreate.resourceCloudStackIPAddressCreatepasses the value through toAssociateIpAddressParams.SetIpaddresswhen set.Read/Delete— the allocated address was already read backfrom the API response.
TestAccCloudStackIPAddress_specificIP, requesting aspecific address from a dedicated
cloudstack_vlan_ip_rangeso theassertion is deterministic (the shared default pool can't guarantee a given
address is free).
website/docs/r/ipaddress.html.markdown.Backward compatibility
Since
ip_addresswasComputed-only before this change, no existingconfiguration could have set it — Terraform rejects a config value for a
Computed-only attribute at validate time. The schema change is purelyadditive; existing state with
ip_addresspopulated shows no diff.Testing
Verified against a simulator
cloudstack_ipaddressacceptance tests pass unchanged(
_basic,_vpc,_vpcid_with_network_id)._specificIPtest passes.data_source_cloudstack_ipaddress,cloudstack_loadbalancer_rule(all 5 variants),cloudstack_static_nat.terraform plan/applywithip_addressset and unchangedproduces no diff and performs no actions; same when
ip_addressisomitted from config against existing state.
both fail clearly with
CloudStack API error 533: Insufficient address capacity— no CloudStack-side ambiguity to handle.ip_addresscorrectly triggersForceNew, scoped to only thecloudstack_ipaddressresource (the associated network is untouched).vpc_id+ip_address, andis_portable = true+ip_address— both workcorrectly and are idempotent.